package com.xq.springboot.config;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author xq
 * @version 1.0
 * @date 2021/4/18 18:39
 * @description swagger2自动配置类
 */
@Configuration
@EnableSwagger2 // 启用swagger2
public class Swagger2AutoConfiguration {

    /**
     * swagger和SpringMvc插件
     * @return
     */
    @Bean
    public Docket swaggerSpringMvcPlugin() {
        return new Docket(DocumentationType.SWAGGER_2)
                // 这个可以自定义页面出现的标题，描述信息等
                .apiInfo(this.apiInfo())
                // 开启swagger2
                .enable(true)
                .select()
                // 指定扫描包
                // .apis(RequestHandlerSelectors.basePackage("com.xq.springboot.controller"))
                // 扫描所有的方法上的@ApiOperation注解
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 构建项目
                .build();
    }

    /**
     * 获取swagger2的Api相关信息
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置项目描述
                .description("这是一个SpringBoot集成Swagger2的Api工具")
                // 配置名片（作者和网址和邮箱）
                .contact(new Contact("枫君启奏","http://www.fengjun.com","2803095118@qq.com"))
                // 设置项目版本
                .version("1.0.0")
                // 设置许可人
                .license("枫君启奏")
                // 构成
                .build();
    }
}
